<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>EhCacheInterceptor xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/com/googlecode/ehcache/annotations/interceptor/EhCacheInterceptor.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright 2010 Nicholas Blair, Eric Dalquist</em>
<a name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> *</em>
<a name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * you may not use this file except in compliance with the License.</em>
<a name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * You may obtain a copy of the License at</em>
<a name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> *   <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, software</em>
<a name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * See the License for the specific language governing permissions and</em>
<a name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * limitations under the License.</em>
<a name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> */</em>
<a name="16" href="#16">16</a>  
<a name="17" href="#17">17</a>  <strong class="jxr_keyword">package</strong> com.googlecode.ehcache.annotations.interceptor;
<a name="18" href="#18">18</a>  
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.lang.reflect.AccessibleObject;
<a name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.lang.reflect.Method;
<a name="22" href="#22">22</a>  <strong class="jxr_keyword">import</strong> java.util.Arrays;
<a name="23" href="#23">23</a>  
<a name="24" href="#24">24</a>  <strong class="jxr_keyword">import</strong> net.sf.ehcache.Ehcache;
<a name="25" href="#25">25</a>  <strong class="jxr_keyword">import</strong> net.sf.ehcache.Element;
<a name="26" href="#26">26</a>  <strong class="jxr_keyword">import</strong> net.sf.ehcache.constructs.blocking.CacheEntryFactory;
<a name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> net.sf.ehcache.constructs.blocking.SelfPopulatingCache;
<a name="28" href="#28">28</a>  
<a name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.aopalliance.intercept.MethodInterceptor;
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.aopalliance.intercept.MethodInvocation;
<a name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.slf4j.Logger;
<a name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory;
<a name="33" href="#33">33</a>  
<a name="34" href="#34">34</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.AdviceType;
<a name="35" href="#35">35</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.CacheAttributeSource;
<a name="36" href="#36">36</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.Cacheable;
<a name="37" href="#37">37</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.CacheableAttribute;
<a name="38" href="#38">38</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.MethodAttribute;
<a name="39" href="#39">39</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.TriggersRemove;
<a name="40" href="#40">40</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.TriggersRemoveAttribute;
<a name="41" href="#41">41</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.When;
<a name="42" href="#42">42</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.impl.ParameterMask;
<a name="43" href="#43">43</a>  <strong class="jxr_keyword">import</strong> com.googlecode.ehcache.annotations.key.CacheKeyGenerator;
<a name="44" href="#44">44</a>  
<a name="45" href="#45">45</a>  
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment">/**</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * Intercepter that handles invocations on methods annotated with {@link Cacheable} or {@link TriggersRemove}.</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * </em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * @author Eric Dalquist</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * @version $Revision: 555 $</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> */</em>
<a name="52" href="#52">52</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/googlecode/ehcache/annotations/interceptor/EhCacheInterceptor.html">EhCacheInterceptor</a> implements MethodInterceptor {
<a name="53" href="#53">53</a>      <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> Logger logger = LoggerFactory.getLogger(<strong class="jxr_keyword">this</strong>.getClass());
<a name="54" href="#54">54</a>      
<a name="55" href="#55">55</a>      <strong class="jxr_keyword">private</strong> <a href="../../../../../com/googlecode/ehcache/annotations/CacheAttributeSource.html">CacheAttributeSource</a> cacheAttributeSource;
<a name="56" href="#56">56</a>  
<a name="57" href="#57">57</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setCacheAttributeSource(<a href="../../../../../com/googlecode/ehcache/annotations/CacheAttributeSource.html">CacheAttributeSource</a> cacheableAttributeSource) {
<a name="58" href="#58">58</a>          <strong class="jxr_keyword">this</strong>.cacheAttributeSource = cacheableAttributeSource;
<a name="59" href="#59">59</a>      }
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>      <em class="jxr_comment">/*<em class="jxr_comment"> (non-Javadoc)</em></em>
<a name="62" href="#62">62</a>  <em class="jxr_comment">     * @see org.aopalliance.intercept.MethodInterceptor#invoke(org.aopalliance.intercept.MethodInvocation)</em>
<a name="63" href="#63">63</a>  <em class="jxr_comment">     */</em>
<a name="64" href="#64">64</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> Object invoke(<strong class="jxr_keyword">final</strong> MethodInvocation methodInvocation) <strong class="jxr_keyword">throws</strong> Throwable {
<a name="65" href="#65">65</a>          <strong class="jxr_keyword">final</strong> Method method = methodInvocation.getMethod();
<a name="66" href="#66">66</a>          <strong class="jxr_keyword">final</strong> Class&lt;?&gt; targetClass = (methodInvocation.getThis() != <strong class="jxr_keyword">null</strong> ? methodInvocation.getThis().getClass() : <strong class="jxr_keyword">null</strong>);
<a name="67" href="#67">67</a>          <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/AdviceType.html">AdviceType</a> adviceType = <strong class="jxr_keyword">this</strong>.cacheAttributeSource.getAdviceType(method, targetClass);
<a name="68" href="#68">68</a>          
<a name="69" href="#69">69</a>          <strong class="jxr_keyword">switch</strong> (adviceType) {
<a name="70" href="#70">70</a>              <strong class="jxr_keyword">case</strong> CACHE: {
<a name="71" href="#71">71</a>                  <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/CacheableAttribute.html">CacheableAttribute</a> cacheableAttribute = <strong class="jxr_keyword">this</strong>.cacheAttributeSource.getCacheableAttribute(method, targetClass);
<a name="72" href="#72">72</a>                  <strong class="jxr_keyword">if</strong> (cacheableAttribute == <strong class="jxr_keyword">null</strong>) {
<a name="73" href="#73">73</a>                      <strong class="jxr_keyword">this</strong>.logger.warn(<span class="jxr_string">"CacheAttributeSource.getAdviceType(Method, Class) returned CACHE but CacheAttributeSource.getCacheableAttribute(Method, Class) returned null. Method will be invoked directly with no Cachable advice. Method: {}, Class: {}"</span>, method, targetClass);
<a name="74" href="#74">74</a>                      <strong class="jxr_keyword">return</strong> methodInvocation.proceed();
<a name="75" href="#75">75</a>                  }
<a name="76" href="#76">76</a>                  
<a name="77" href="#77">77</a>                  <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.invokeCacheable(methodInvocation, cacheableAttribute);
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>              }
<a name="80" href="#80">80</a>  
<a name="81" href="#81">81</a>              <strong class="jxr_keyword">case</strong> REMOVE: {
<a name="82" href="#82">82</a>                  <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/TriggersRemoveAttribute.html">TriggersRemoveAttribute</a> triggersRemoveAttribute = <strong class="jxr_keyword">this</strong>.cacheAttributeSource.getTriggersRemoveAttribute(method, targetClass);
<a name="83" href="#83">83</a>                  <strong class="jxr_keyword">if</strong> (triggersRemoveAttribute == <strong class="jxr_keyword">null</strong>) {
<a name="84" href="#84">84</a>                      <strong class="jxr_keyword">this</strong>.logger.warn(<span class="jxr_string">"CacheAttributeSource.getAdviceType(Method, Class) returned REMOVE but CacheAttributeSource.getTriggersRemoveAttribute(Method, Class) returned null. Method will be invoked directly with no TriggersFlush advice. Method: {}, Class: {}"</span>, method, targetClass);
<a name="85" href="#85">85</a>                      <strong class="jxr_keyword">return</strong> methodInvocation.proceed();
<a name="86" href="#86">86</a>                  }
<a name="87" href="#87">87</a>                  
<a name="88" href="#88">88</a>                  <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.invokeTriggersRemove(methodInvocation, triggersRemoveAttribute);
<a name="89" href="#89">89</a>              }
<a name="90" href="#90">90</a>              
<a name="91" href="#91">91</a>              <strong class="jxr_keyword">default</strong>: {
<a name="92" href="#92">92</a>                  <strong class="jxr_keyword">this</strong>.logger.trace(<span class="jxr_string">"The method {} is not advised {}."</span>, methodInvocation, adviceType);
<a name="93" href="#93">93</a>                  <strong class="jxr_keyword">return</strong> methodInvocation.proceed();
<a name="94" href="#94">94</a>              }
<a name="95" href="#95">95</a>          }
<a name="96" href="#96">96</a>      }
<a name="97" href="#97">97</a>      
<a name="98" href="#98">98</a>      <em class="jxr_javadoccomment">/**</em>
<a name="99" href="#99">99</a>  <em class="jxr_javadoccomment">     * Called if the {@link MethodInvocation} is annotated with {@link Cacheable}.</em>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">     * </em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">     * @param methodInvocation Original method invocation</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment">     * @param cacheableAttribute Information about the {@link Cacheable} annotation</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">     * @return The result of the invocation or the cached result</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">     * @throws Throwable exception thrown by the invocation or cached exception</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">     */</em>
<a name="106" href="#106">106</a>     <strong class="jxr_keyword">private</strong> Object invokeCacheable(<strong class="jxr_keyword">final</strong> MethodInvocation methodInvocation, <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/CacheableAttribute.html">CacheableAttribute</a> cacheableAttribute) <strong class="jxr_keyword">throws</strong> Throwable {
<a name="107" href="#107">107</a>         <em class="jxr_comment">//Generate the cache key</em>
<a name="108" href="#108">108</a>         <strong class="jxr_keyword">final</strong> Serializable cacheKey = <strong class="jxr_keyword">this</strong>.generateCacheKey(methodInvocation, cacheableAttribute);
<a name="109" href="#109">109</a>         
<a name="110" href="#110">110</a>         <strong class="jxr_keyword">this</strong>.checkForCachedException(cacheableAttribute, cacheKey);
<a name="111" href="#111">111</a>         
<a name="112" href="#112">112</a>         <em class="jxr_comment">//See if this is self-populating</em>
<a name="113" href="#113">113</a>         <strong class="jxr_keyword">if</strong> (cacheableAttribute.getEntryFactory() != <strong class="jxr_keyword">null</strong>) {
<a name="114" href="#114">114</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.invokeSelfPopulatingCacheable(methodInvocation, cacheableAttribute, cacheKey);
<a name="115" href="#115">115</a>         }
<a name="116" href="#116">116</a> 
<a name="117" href="#117">117</a>         <em class="jxr_comment">//See if there is a cached result</em>
<a name="118" href="#118">118</a>         <strong class="jxr_keyword">final</strong> Ehcache cache = cacheableAttribute.getCache();
<a name="119" href="#119">119</a>         <strong class="jxr_keyword">final</strong> Element element = cache.get(cacheKey);
<a name="120" href="#120">120</a>         <strong class="jxr_keyword">if</strong> (element != <strong class="jxr_keyword">null</strong>) {
<a name="121" href="#121">121</a>             <strong class="jxr_keyword">return</strong> element.getObjectValue();
<a name="122" href="#122">122</a>         }
<a name="123" href="#123">123</a> 
<a name="124" href="#124">124</a>         <em class="jxr_comment">//No cached value or exception, proceed</em>
<a name="125" href="#125">125</a>         <strong class="jxr_keyword">final</strong> Object value;
<a name="126" href="#126">126</a>         <strong class="jxr_keyword">try</strong> {
<a name="127" href="#127">127</a>             value = methodInvocation.proceed();
<a name="128" href="#128">128</a>         }
<a name="129" href="#129">129</a>         <strong class="jxr_keyword">catch</strong> (Throwable t) {
<a name="130" href="#130">130</a>             <strong class="jxr_keyword">this</strong>.cacheException(cacheableAttribute, cacheKey, t);
<a name="131" href="#131">131</a>             <strong class="jxr_keyword">throw</strong> t;
<a name="132" href="#132">132</a>         }
<a name="133" href="#133">133</a>         
<a name="134" href="#134">134</a>         <em class="jxr_comment">//Cache and return the value</em>
<a name="135" href="#135">135</a>         cache.put(<strong class="jxr_keyword">new</strong> Element(cacheKey, value));
<a name="136" href="#136">136</a>         <strong class="jxr_keyword">return</strong> value;
<a name="137" href="#137">137</a>     }
<a name="138" href="#138">138</a> 
<a name="139" href="#139">139</a>     <em class="jxr_javadoccomment">/**</em>
<a name="140" href="#140">140</a> <em class="jxr_javadoccomment">     * Handles invoking the advised method via a {@link SelfPopulatingCache}. The {@link MethodInvocation} is set into</em>
<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">     * a {@link ThreadLocal} which is used by the {@link CacheEntryFactory} to create the object if needed.</em>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">     * </em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment">     * @param methodInvocation The advised invocation</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">     * @param cacheableAttribute Configuration for the method invocation</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment">     * @param key The cache key for the invocation</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">     * @return The result of the invocation or the cached result.</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">     * @throws Throwable Exception from the invocation</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment">     */</em>
<a name="149" href="#149">149</a>     <strong class="jxr_keyword">private</strong> Object invokeSelfPopulatingCacheable(<strong class="jxr_keyword">final</strong> MethodInvocation methodInvocation, <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/CacheableAttribute.html">CacheableAttribute</a> cacheableAttribute, <strong class="jxr_keyword">final</strong> Serializable key) <strong class="jxr_keyword">throws</strong> Throwable {
<a name="150" href="#150">150</a>         <strong class="jxr_keyword">final</strong> Ehcache cache = cacheableAttribute.getCache();
<a name="151" href="#151">151</a> 
<a name="152" href="#152">152</a>         <strong class="jxr_keyword">final</strong> ThreadLocal&lt;MethodInvocation&gt; entryFactory = cacheableAttribute.getEntryFactory();
<a name="153" href="#153">153</a>         <strong class="jxr_keyword">if</strong> (entryFactory == <strong class="jxr_keyword">null</strong>) {
<a name="154" href="#154">154</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"CacheableAttribute.getEntryFactory() returned null"</span>);
<a name="155" href="#155">155</a>         }
<a name="156" href="#156">156</a>         
<a name="157" href="#157">157</a>         entryFactory.set(methodInvocation);
<a name="158" href="#158">158</a>         <strong class="jxr_keyword">final</strong> Element element;
<a name="159" href="#159">159</a>         <strong class="jxr_keyword">try</strong> {
<a name="160" href="#160">160</a>             element = cache.get(key);
<a name="161" href="#161">161</a>         }
<a name="162" href="#162">162</a>         <strong class="jxr_keyword">catch</strong> (Throwable t) {
<a name="163" href="#163">163</a>             Throwable cause = t.getCause();
<a name="164" href="#164">164</a>             <strong class="jxr_keyword">this</strong>.cacheException(cacheableAttribute, key, cause);
<a name="165" href="#165">165</a>             <strong class="jxr_keyword">throw</strong> cause;
<a name="166" href="#166">166</a>         }
<a name="167" href="#167">167</a>         <strong class="jxr_keyword">finally</strong> {
<a name="168" href="#168">168</a>             entryFactory.remove();
<a name="169" href="#169">169</a>         }
<a name="170" href="#170">170</a>         
<a name="171" href="#171">171</a>         <em class="jxr_comment">//This should not occur, it would have to be from a coding error in this library or EhCache's APIs have changed</em>
<a name="172" href="#172">172</a>         <strong class="jxr_keyword">if</strong> (element == <strong class="jxr_keyword">null</strong>) {
<a name="173" href="#173">173</a>            <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"the supposed SelfPopulatingCache returned null, which violates the contract it should always return an Element; perhaps the cache is not truly a SelfPopulatingCache?"</span>);
<a name="174" href="#174">174</a>         }
<a name="175" href="#175">175</a>         
<a name="176" href="#176">176</a>         <strong class="jxr_keyword">return</strong> element.getObjectValue();
<a name="177" href="#177">177</a>     }
<a name="178" href="#178">178</a>     
<a name="179" href="#179">179</a>     <em class="jxr_javadoccomment">/**</em>
<a name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * Called if the {@link MethodInvocation} is annotated with {@link TriggersRemove}.</em>
<a name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * </em>
<a name="182" href="#182">182</a> <em class="jxr_javadoccomment">     * @param methodInvocation Original method invocation</em>
<a name="183" href="#183">183</a> <em class="jxr_javadoccomment">     * @param triggersRemoveAttribute Information about the {@link TriggersRemove} annotation</em>
<a name="184" href="#184">184</a> <em class="jxr_javadoccomment">     * @return The result of the invocation</em>
<a name="185" href="#185">185</a> <em class="jxr_javadoccomment">     * @throws Throwable exception thrown by the invocation</em>
<a name="186" href="#186">186</a> <em class="jxr_javadoccomment">     */</em>
<a name="187" href="#187">187</a>     <strong class="jxr_keyword">private</strong> Object invokeTriggersRemove(<strong class="jxr_keyword">final</strong> MethodInvocation methodInvocation, <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/TriggersRemoveAttribute.html">TriggersRemoveAttribute</a> triggersRemoveAttribute) <strong class="jxr_keyword">throws</strong> Throwable {
<a name="188" href="#188">188</a>         <strong class="jxr_keyword">final</strong> Iterable&lt;Ehcache&gt; caches = triggersRemoveAttribute.getCaches();
<a name="189" href="#189">189</a>         
<a name="190" href="#190">190</a>         <strong class="jxr_keyword">if</strong>(When.BEFORE_METHOD_INVOCATION.equals(triggersRemoveAttribute.getWhen())) {
<a name="191" href="#191">191</a>             invokeCacheRemove(methodInvocation, triggersRemoveAttribute, caches);
<a name="192" href="#192">192</a>             <strong class="jxr_keyword">return</strong> methodInvocation.proceed();
<a name="193" href="#193">193</a>         }
<a name="194" href="#194">194</a>         
<a name="195" href="#195">195</a>         <strong class="jxr_keyword">final</strong> Object methodInvocationResult =  methodInvocation.proceed();
<a name="196" href="#196">196</a>         invokeCacheRemove(methodInvocation, triggersRemoveAttribute, caches);
<a name="197" href="#197">197</a>         <strong class="jxr_keyword">return</strong> methodInvocationResult;
<a name="198" href="#198">198</a>     }
<a name="199" href="#199">199</a> 
<a name="200" href="#200">200</a>     <em class="jxr_javadoccomment">/**</em>
<a name="201" href="#201">201</a> <em class="jxr_javadoccomment">     * Call the ehcache remove function as prescribed by the {@link TriggersRemoveAttribute}.</em>
<a name="202" href="#202">202</a> <em class="jxr_javadoccomment">     * </em>
<a name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * @param methodInvocation</em>
<a name="204" href="#204">204</a> <em class="jxr_javadoccomment">     * @param triggersRemoveAttribute</em>
<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * @param cache</em>
<a name="206" href="#206">206</a> <em class="jxr_javadoccomment">     */</em>
<a name="207" href="#207">207</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> invokeCacheRemove(<strong class="jxr_keyword">final</strong> MethodInvocation methodInvocation,
<a name="208" href="#208">208</a>             <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/TriggersRemoveAttribute.html">TriggersRemoveAttribute</a> triggersRemoveAttribute,
<a name="209" href="#209">209</a>             <strong class="jxr_keyword">final</strong> Iterable&lt;Ehcache&gt; caches) {
<a name="210" href="#210">210</a>         <strong class="jxr_keyword">if</strong> (triggersRemoveAttribute.isRemoveAll()) {
<a name="211" href="#211">211</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Ehcache ehcache : caches) {
<a name="212" href="#212">212</a>                 ehcache.removeAll();
<a name="213" href="#213">213</a>             }
<a name="214" href="#214">214</a>         }
<a name="215" href="#215">215</a>         <strong class="jxr_keyword">else</strong> {
<a name="216" href="#216">216</a>             <strong class="jxr_keyword">final</strong> Serializable cacheKey = generateCacheKey(methodInvocation, triggersRemoveAttribute);
<a name="217" href="#217">217</a>             <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> Ehcache ehcache : caches) {
<a name="218" href="#218">218</a>                 ehcache.remove(cacheKey);
<a name="219" href="#219">219</a>             }
<a name="220" href="#220">220</a>         }
<a name="221" href="#221">221</a>     }
<a name="222" href="#222">222</a> 
<a name="223" href="#223">223</a>     <em class="jxr_javadoccomment">/**</em>
<a name="224" href="#224">224</a> <em class="jxr_javadoccomment">     * Check if there is a cached exception for the key. If there is throw it.</em>
<a name="225" href="#225">225</a> <em class="jxr_javadoccomment">     * </em>
<a name="226" href="#226">226</a> <em class="jxr_javadoccomment">     * @param cacheableAttribute Configuration for the method invocation</em>
<a name="227" href="#227">227</a> <em class="jxr_javadoccomment">     * @param key The cache key for the method invocation</em>
<a name="228" href="#228">228</a> <em class="jxr_javadoccomment">     * @throws Throwable The cached throwable</em>
<a name="229" href="#229">229</a> <em class="jxr_javadoccomment">     */</em>
<a name="230" href="#230">230</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkForCachedException(<strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/CacheableAttribute.html">CacheableAttribute</a> cacheableAttribute, <strong class="jxr_keyword">final</strong> Serializable key) <strong class="jxr_keyword">throws</strong> Throwable {
<a name="231" href="#231">231</a>         <em class="jxr_comment">//Determine if exception caching is enabled</em>
<a name="232" href="#232">232</a>         <strong class="jxr_keyword">final</strong> Ehcache exceptionCache = cacheableAttribute.getExceptionCache();
<a name="233" href="#233">233</a>         <strong class="jxr_keyword">if</strong> (exceptionCache != <strong class="jxr_keyword">null</strong>) {
<a name="234" href="#234">234</a>             <em class="jxr_comment">//See if there is a cached exception</em>
<a name="235" href="#235">235</a>             <strong class="jxr_keyword">final</strong> Element execptionElement = exceptionCache.get(key);
<a name="236" href="#236">236</a>             <strong class="jxr_keyword">if</strong> (execptionElement != <strong class="jxr_keyword">null</strong>) {
<a name="237" href="#237">237</a>                 <strong class="jxr_keyword">throw</strong> (Throwable)execptionElement.getObjectValue();
<a name="238" href="#238">238</a>             }
<a name="239" href="#239">239</a>         }
<a name="240" href="#240">240</a>     }
<a name="241" href="#241">241</a> 
<a name="242" href="#242">242</a>     <em class="jxr_javadoccomment">/**</em>
<a name="243" href="#243">243</a> <em class="jxr_javadoccomment">     * Checks {@link CacheableAttribute#getExceptionCache()}, if not null the exception will be cached.</em>
<a name="244" href="#244">244</a> <em class="jxr_javadoccomment">     * </em>
<a name="245" href="#245">245</a> <em class="jxr_javadoccomment">     * @param cacheableAttribute Configuration for the method invocation</em>
<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * @param key Cache key for the invocation</em>
<a name="247" href="#247">247</a> <em class="jxr_javadoccomment">     * @param t The exception to cache</em>
<a name="248" href="#248">248</a> <em class="jxr_javadoccomment">     */</em>
<a name="249" href="#249">249</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> cacheException(<strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/CacheableAttribute.html">CacheableAttribute</a> cacheableAttribute, <strong class="jxr_keyword">final</strong> Serializable key, <strong class="jxr_keyword">final</strong> Throwable t) {
<a name="250" href="#250">250</a>         <strong class="jxr_keyword">final</strong> Ehcache exceptionCache = cacheableAttribute.getExceptionCache();
<a name="251" href="#251">251</a>         <strong class="jxr_keyword">if</strong> (exceptionCache != <strong class="jxr_keyword">null</strong>) {
<a name="252" href="#252">252</a>             exceptionCache.put(<strong class="jxr_keyword">new</strong> Element(key, t));
<a name="253" href="#253">253</a>         }
<a name="254" href="#254">254</a>     }
<a name="255" href="#255">255</a> 
<a name="256" href="#256">256</a>     <em class="jxr_javadoccomment">/**</em>
<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">     * Creates a {@link Serializable} cache key from the {@link MethodInvocation} and configuration attributes.</em>
<a name="258" href="#258">258</a> <em class="jxr_javadoccomment">     * </em>
<a name="259" href="#259">259</a> <em class="jxr_javadoccomment">     * @param methodInvocation Invocation to build the key for</em>
<a name="260" href="#260">260</a> <em class="jxr_javadoccomment">     * @param methodAttribute Configuration for the invoked method</em>
<a name="261" href="#261">261</a> <em class="jxr_javadoccomment">     * @return Generated cache key, must not return null.</em>
<a name="262" href="#262">262</a> <em class="jxr_javadoccomment">     */</em>
<a name="263" href="#263">263</a>     <strong class="jxr_keyword">protected</strong> Serializable generateCacheKey(MethodInvocation methodInvocation, <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/MethodAttribute.html">MethodAttribute</a> methodAttribute) {
<a name="264" href="#264">264</a>         <strong class="jxr_keyword">final</strong> CacheKeyGenerator&lt;? <strong class="jxr_keyword">extends</strong> Serializable&gt; cacheKeyGenerator = methodAttribute.getCacheKeyGenerator();
<a name="265" href="#265">265</a>         
<a name="266" href="#266">266</a>         <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/impl/ParameterMask.html">ParameterMask</a> parameterMask = methodAttribute.getCacheKeyParameterMask();
<a name="267" href="#267">267</a>         <strong class="jxr_keyword">if</strong> (parameterMask.shouldMask()) {
<a name="268" href="#268">268</a>             methodInvocation = <strong class="jxr_keyword">new</strong> <a href="../../../../../com/googlecode/ehcache/annotations/interceptor/EhCacheInterceptor.html">ParameterFilteringMethodInvocation</a>(methodInvocation, parameterMask);
<a name="269" href="#269">269</a>         }
<a name="270" href="#270">270</a>         
<a name="271" href="#271">271</a>         <strong class="jxr_keyword">final</strong> Serializable cacheKey = cacheKeyGenerator.generateKey(methodInvocation);
<a name="272" href="#272">272</a>         <strong class="jxr_keyword">this</strong>.logger.debug(<span class="jxr_string">"Generated key '{}' for invocation: {}"</span>, cacheKey, methodInvocation);
<a name="273" href="#273">273</a>         <strong class="jxr_keyword">return</strong> cacheKey;
<a name="274" href="#274">274</a>     }
<a name="275" href="#275">275</a>     
<a name="276" href="#276">276</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../com/googlecode/ehcache/annotations/interceptor/EhCacheInterceptor.html">ParameterFilteringMethodInvocation</a> implements MethodInvocation {
<a name="277" href="#277">277</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> MethodInvocation methodInvocation;
<a name="278" href="#278">278</a>         <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../com/googlecode/ehcache/annotations/impl/ParameterMask.html">ParameterMask</a> parameterMask;
<a name="279" href="#279">279</a>         <strong class="jxr_keyword">private</strong> Object[] filteredArguments = <strong class="jxr_keyword">null</strong>;
<a name="280" href="#280">280</a>         
<a name="281" href="#281">281</a>         <strong class="jxr_keyword">public</strong> <a href="../../../../../com/googlecode/ehcache/annotations/interceptor/EhCacheInterceptor.html">ParameterFilteringMethodInvocation</a>(MethodInvocation methodInvocation, <a href="../../../../../com/googlecode/ehcache/annotations/impl/ParameterMask.html">ParameterMask</a> parameterMask) {
<a name="282" href="#282">282</a>             <strong class="jxr_keyword">this</strong>.methodInvocation = methodInvocation;
<a name="283" href="#283">283</a>             <strong class="jxr_keyword">this</strong>.parameterMask = parameterMask;
<a name="284" href="#284">284</a>         }
<a name="285" href="#285">285</a> 
<a name="286" href="#286">286</a>         <strong class="jxr_keyword">public</strong> Object[] getArguments() {
<a name="287" href="#287">287</a>             <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.filteredArguments == <strong class="jxr_keyword">null</strong>) {
<a name="288" href="#288">288</a>                 <strong class="jxr_keyword">final</strong> Object[] arguments = <strong class="jxr_keyword">this</strong>.methodInvocation.getArguments();
<a name="289" href="#289">289</a>                 <strong class="jxr_keyword">this</strong>.filteredArguments = <strong class="jxr_keyword">this</strong>.parameterMask.maskParameters(arguments);
<a name="290" href="#290">290</a>             }
<a name="291" href="#291">291</a>             
<a name="292" href="#292">292</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.filteredArguments;
<a name="293" href="#293">293</a>         }
<a name="294" href="#294">294</a> 
<a name="295" href="#295">295</a>         <strong class="jxr_keyword">public</strong> Method getMethod() {
<a name="296" href="#296">296</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.methodInvocation.getMethod();
<a name="297" href="#297">297</a>         }
<a name="298" href="#298">298</a> 
<a name="299" href="#299">299</a>         <strong class="jxr_keyword">public</strong> AccessibleObject getStaticPart() {
<a name="300" href="#300">300</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.methodInvocation.getStaticPart();
<a name="301" href="#301">301</a>         }
<a name="302" href="#302">302</a> 
<a name="303" href="#303">303</a>         <strong class="jxr_keyword">public</strong> Object getThis() {
<a name="304" href="#304">304</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.methodInvocation.getThis();
<a name="305" href="#305">305</a>         }
<a name="306" href="#306">306</a> 
<a name="307" href="#307">307</a>         <strong class="jxr_keyword">public</strong> Object proceed() <strong class="jxr_keyword">throws</strong> Throwable {
<a name="308" href="#308">308</a>             <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.filteredArguments != <strong class="jxr_keyword">null</strong>) {
<a name="309" href="#309">309</a>                 <strong class="jxr_keyword">final</strong> Object[] arguments = <strong class="jxr_keyword">this</strong>.methodInvocation.getArguments();
<a name="310" href="#310">310</a>                 <strong class="jxr_keyword">this</strong>.parameterMask.unmaskParameters(arguments, <strong class="jxr_keyword">this</strong>.filteredArguments);
<a name="311" href="#311">311</a>             }
<a name="312" href="#312">312</a>             
<a name="313" href="#313">313</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.methodInvocation.proceed();
<a name="314" href="#314">314</a>         }
<a name="315" href="#315">315</a> 
<a name="316" href="#316">316</a>         @Override
<a name="317" href="#317">317</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a name="318" href="#318">318</a>             <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> prime = 31;
<a name="319" href="#319">319</a>             <strong class="jxr_keyword">int</strong> result = 1;
<a name="320" href="#320">320</a>             result = prime * result + Arrays.hashCode(<strong class="jxr_keyword">this</strong>.filteredArguments);
<a name="321" href="#321">321</a>             result = prime * result + ((<strong class="jxr_keyword">this</strong>.methodInvocation == <strong class="jxr_keyword">null</strong>) ? 0 : <strong class="jxr_keyword">this</strong>.methodInvocation.hashCode());
<a name="322" href="#322">322</a>             <strong class="jxr_keyword">return</strong> result;
<a name="323" href="#323">323</a>         }
<a name="324" href="#324">324</a> 
<a name="325" href="#325">325</a>         @Override
<a name="326" href="#326">326</a>         <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object obj) {
<a name="327" href="#327">327</a>             <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == obj) {
<a name="328" href="#328">328</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="329" href="#329">329</a>             }
<a name="330" href="#330">330</a>             <strong class="jxr_keyword">if</strong> (obj == <strong class="jxr_keyword">null</strong>) {
<a name="331" href="#331">331</a>                 <strong class="jxr_keyword">return</strong> false;
<a name="332" href="#332">332</a>             }
<a name="333" href="#333">333</a>             <strong class="jxr_keyword">if</strong> (getClass() != obj.getClass()) {
<a name="334" href="#334">334</a>                 <strong class="jxr_keyword">return</strong> false;
<a name="335" href="#335">335</a>             }
<a name="336" href="#336">336</a>             <a href="../../../../../com/googlecode/ehcache/annotations/interceptor/EhCacheInterceptor.html">ParameterFilteringMethodInvocation</a> other = (ParameterFilteringMethodInvocation) obj;
<a name="337" href="#337">337</a>             <strong class="jxr_keyword">if</strong> (!Arrays.equals(<strong class="jxr_keyword">this</strong>.filteredArguments, other.filteredArguments)) {
<a name="338" href="#338">338</a>                 <strong class="jxr_keyword">return</strong> false;
<a name="339" href="#339">339</a>             }
<a name="340" href="#340">340</a>             <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.methodInvocation == <strong class="jxr_keyword">null</strong>) {
<a name="341" href="#341">341</a>                 <strong class="jxr_keyword">if</strong> (other.methodInvocation != <strong class="jxr_keyword">null</strong>) {
<a name="342" href="#342">342</a>                     <strong class="jxr_keyword">return</strong> false;
<a name="343" href="#343">343</a>                 }
<a name="344" href="#344">344</a>             }
<a name="345" href="#345">345</a>             <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.methodInvocation.equals(other.methodInvocation)) {
<a name="346" href="#346">346</a>                 <strong class="jxr_keyword">return</strong> false;
<a name="347" href="#347">347</a>             }
<a name="348" href="#348">348</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a name="349" href="#349">349</a>         }
<a name="350" href="#350">350</a> 
<a name="351" href="#351">351</a>         @Override
<a name="352" href="#352">352</a>         <strong class="jxr_keyword">public</strong> String toString() {
<a name="353" href="#353">353</a>             <strong class="jxr_keyword">return</strong> <span class="jxr_string">"ParameterFilteringMethodInvocation [filteredArguments="</span> + Arrays.toString(<strong class="jxr_keyword">this</strong>.filteredArguments)
<a name="354" href="#354">354</a>                     + <span class="jxr_string">", methodInvocation="</span> + <strong class="jxr_keyword">this</strong>.methodInvocation + <span class="jxr_string">"]"</span>;
<a name="355" href="#355">355</a>         }
<a name="356" href="#356">356</a>     }
<a name="357" href="#357">357</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

